From c85de9ccfdd50bf236b3fa48004cb658be5c0935 Mon Sep 17 00:00:00 2001 From: Eduardo Bautista Date: Sat, 6 Sep 2014 23:38:28 -0500 Subject: [PATCH] Make docs more generic --- src/doc/source/guide.md | 30 +++++++++++++++--------------- src/doc/source/index.md | 6 +++--- src/doc/source/manifest.md | 2 +- src/doc/source/native-build.md | 4 ++-- 4 files changed, 21 insertions(+), 21 deletions(-) diff --git a/src/doc/source/guide.md b/src/doc/source/guide.md index a57df78b4..13d99f54c 100644 --- a/src/doc/source/guide.md +++ b/src/doc/source/guide.md @@ -57,7 +57,7 @@ This is all we need to get started. First, let's check out `Cargo.toml`: name = "hello_world" version = "0.0.1" -authors = ["Yehuda Katz "] +authors = ["Your Name "] ``` This is called a **manifest**, and it contains all of the metadata that Cargo @@ -75,7 +75,7 @@ Cargo generated a 'hello world' for us. Let's compile it: 
$ cargo build
    Compiling hello_world v0.0.1 (file:///Users/wycats/src/hello_world)
+class="s1"> Compiling hello_world v0.0.1 (file:///path/to/project/hello_world) And then run it: @@ -88,7 +88,7 @@ We can also use `cargo run` to compile and then run it, all in one step: 
$ cargo run
    Fresh hello-world v0.0.1 (file:///Users/wycats/src/hello_world)
+class="s1">   Fresh hello-world v0.0.1 (file:///path/to/project/hello_world)
    Running `target/hello_world`
 Hello world!
@@ -111,7 +111,7 @@ $ cd color-rs To build, just use `cargo build`: 
$ cargo build
-   Compiling color v0.0.1 (file:///Users/wycats/src/color-rs)
+ Compiling color v0.0.1 (file:///path/to/project/color-rs) This will fetch all of the dependencies and then build them, along with the project. @@ -125,7 +125,7 @@ To depend on a library, add it to your `Cargo.toml`. name = "hello-world" version = "0.0.1" -authors = ["Yehuda Katz "] +authors = ["Your Name "] [dependencies.color] @@ -159,7 +159,7 @@ Compile it: 
$ cargo run
    Compiling color v0.0.1 (https://github.com/bjz/color-rs.git#bf739419)
-   Compiling hello-world v0.0.1 (file:///Users/wycats/src/hello_world)
+   Compiling hello-world v0.0.1 (file:///path/to/project/hello_world)
      Running `target/hello_world`
 Converting RGB to HSV!
 HSV: HSV { h: 0, s: 1, v: 1 }
@@ -218,7 +218,7 @@ on another project: name = "hello_world" version = "0.0.1" -authors = ["Yehuda Katz "] +authors = ["Your Name "] [dependencies.color] @@ -258,7 +258,7 @@ manifest like this: name = "hello_world" version = "0.0.1" -authors = ["Yehuda Katz "] +authors = ["Your Name "] [dependencies.color] @@ -333,13 +333,13 @@ building your package, it will use the override on your local machine instead of the source specified in your `Cargo.toml`. Cargo looks for a directory named `.cargo` up the directory hierarchy of -your project. If your project is in `/Users/wycats/src/conduit-static`, +your project. If your project is in `/path/to/project/conduit-static`, it will search for a `.cargo` in: -* `/Users/wycats/src/conduit-static` -* `/Users/wycats/src` -* `/Users/wycats` -* `/Users` +* `/path/to/project/conduit-static` +* `/path/to/project` +* `/path/to` +* `/path` * `/` This allows you to specify your overrides in a parent directory that @@ -353,7 +353,7 @@ your code directory or in your home directory). Inside that file, put this: ``` -paths = ["/Users/wycats/src/conduit"] +paths = ["/path/to/project/conduit"] ``` This array should be filled with directories that contain a `Cargo.toml`. In @@ -377,7 +377,7 @@ To run your tests, just run `cargo test`: Compiling color v0.0.1 (https://github.com/bjz/color-rs.git#bf739419) Compiling hello-world v0.0.1 (file:///Users/wycats/src/hello_world) +class="s1"> Compiling hello-world v0.0.1 (file:///path/to/project/hello_world) Running target/test/hello_world-9c2b65bbb79eabce diff --git a/src/doc/source/index.md b/src/doc/source/index.md index cbc627326..c599fef21 100644 --- a/src/doc/source/index.md +++ b/src/doc/source/index.md @@ -50,7 +50,7 @@ This is all we need to get started. First, let's check out `Cargo.toml`: name = "hello_world" version = "0.0.1" -authors = ["Yehuda Katz "] +authors = ["Your Name "] ``` This is called a **manifest**, and it contains all of the metadata that Cargo @@ -68,7 +68,7 @@ Cargo generated a 'hello world' for us. Let's compile it: 
$ cargo build
    Compiling hello_world v0.0.1 (file:///Users/wycats/src/hello_world)
+class="s1"> Compiling hello_world v0.0.1 (file:///path/to/project/hello_world) And then run it: @@ -81,7 +81,7 @@ We can also use `cargo run` to compile and then run it, all in one step: 
$ cargo run
    Fresh hello-world v0.1.0 (file:///Users/wycats/src/hello_world)
+class="s1">   Fresh hello-world v0.0.1 (file:///path/to/project/hello_world)
    Running `target/hello_world`
 Hello world!
diff --git a/src/doc/source/manifest.md b/src/doc/source/manifest.md index 9e70b5988..10ae987c6 100644 --- a/src/doc/source/manifest.md +++ b/src/doc/source/manifest.md @@ -10,7 +10,7 @@ The first section in a `Cargo.toml` is `[package]`. [package] name = "hello-world" # the name of the package version = "1.0.0" # the current version, obeying semver -authors = [ "wycats@example.com" ] +authors = [ "you@example.com" ] ``` All three of these fields are mandatory. Cargo bakes in the concept of diff --git a/src/doc/source/native-build.md b/src/doc/source/native-build.md index 5c6371949..8f3739ed9 100644 --- a/src/doc/source/native-build.md +++ b/src/doc/source/native-build.md @@ -15,7 +15,7 @@ configuration option. name = "hello-world-from-c" version = "0.1.0" -authors = [ "wycats@gmail.com" ] +authors = [ "you@example.com" ] build = "make" ``` @@ -91,7 +91,7 @@ program. name = "hello-world-from-c" version = "0.1.0" -authors = [ "wycats@gmail.com" ] +authors = [ "you@example.com" ] build = "make -C build" ``` -- 2.30.2